<!DOCTYPE HTML>

<html lang="en">
<head>

<title>ThrowableAnalyzer (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="ThrowableAnalyzer (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="ThrowableAnalyzer.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="ThrowableAnalyzer.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="ThrowableAnalyzer.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="ThrowableAnalyzer.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="ThrowableAnalyzer.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="ThrowableAnalyzer.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="ThrowableAnalyzer.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.web.util</a></div>
<h2 title="Class ThrowableAnalyzer" class="title">Class ThrowableAnalyzer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.security.web.util.ThrowableAnalyzer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">ThrowableAnalyzer</span>
extends java.lang.Object</pre>
<div class="block">Handler for analyzing <code>Throwable</code> instances.
Can be subclassed to customize its behavior.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">

</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="ThrowableCauseExtractor.html" title="interface in org.springframework.security.web.util">ThrowableCauseExtractor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ThrowableAnalyzer.html#DEFAULT_EXTRACTOR">DEFAULT_EXTRACTOR</a></span></code></th>
<td class="colLast">
<div class="block">Default extractor for <code>Throwable</code> instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="ThrowableCauseExtractor.html" title="interface in org.springframework.security.web.util">ThrowableCauseExtractor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ThrowableAnalyzer.html#INVOCATIONTARGET_EXTRACTOR">INVOCATIONTARGET_EXTRACTOR</a></span></code></th>
<td class="colLast">
<div class="block">Default extractor for <code>InvocationTargetException</code> instances.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="ThrowableAnalyzer.html#%3Cinit%3E()">ThrowableAnalyzer</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new <code>ThrowableAnalyzer</code> instance.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.Throwable[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ThrowableAnalyzer.html#determineCauseChain(java.lang.Throwable)">determineCauseChain</a></span>&#8203;(java.lang.Throwable&nbsp;throwable)</code></th>
<td class="colLast">
<div class="block">Determines the cause chain of the provided <code>Throwable</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.Throwable</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ThrowableAnalyzer.html#getFirstThrowableOfType(java.lang.Class,java.lang.Throwable%5B%5D)">getFirstThrowableOfType</a></span>&#8203;(java.lang.Class&lt;? extends java.lang.Throwable&gt;&nbsp;throwableType,
java.lang.Throwable[]&nbsp;chain)</code></th>
<td class="colLast">
<div class="block">Returns the first throwable from the passed in array that is assignable to the
provided type.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ThrowableAnalyzer.html#initExtractorMap()">initExtractorMap</a></span>()</code></th>
<td class="colLast">
<div class="block">Initializes associations between <code>Throwable</code>s and
<code>ThrowableCauseExtractor</code>s.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ThrowableAnalyzer.html#registerExtractor(java.lang.Class,org.springframework.security.web.util.ThrowableCauseExtractor)">registerExtractor</a></span>&#8203;(java.lang.Class&lt;? extends java.lang.Throwable&gt;&nbsp;throwableType,
<a href="ThrowableCauseExtractor.html" title="interface in org.springframework.security.web.util">ThrowableCauseExtractor</a>&nbsp;extractor)</code></th>
<td class="colLast">
<div class="block">Registers a <code>ThrowableCauseExtractor</code> for the specified type.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ThrowableAnalyzer.html#verifyThrowableHierarchy(java.lang.Throwable,java.lang.Class)">verifyThrowableHierarchy</a></span>&#8203;(java.lang.Throwable&nbsp;throwable,
java.lang.Class&lt;? extends java.lang.Throwable&gt;&nbsp;expectedBaseType)</code></th>
<td class="colLast">
<div class="block">Verifies that the provided throwable is a valid subclass of the provided type (or
of the type itself).</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">

</a>
<h3>Field Detail</h3>
<a id="DEFAULT_EXTRACTOR">

</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_EXTRACTOR</h4>
<pre>public static final&nbsp;<a href="ThrowableCauseExtractor.html" title="interface in org.springframework.security.web.util">ThrowableCauseExtractor</a> DEFAULT_EXTRACTOR</pre>
<div class="block">Default extractor for <code>Throwable</code> instances.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Throwable.getCause()</code></dd>
</dl>
</li>
</ul>
<a id="INVOCATIONTARGET_EXTRACTOR">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>INVOCATIONTARGET_EXTRACTOR</h4>
<pre>public static final&nbsp;<a href="ThrowableCauseExtractor.html" title="interface in org.springframework.security.web.util">ThrowableCauseExtractor</a> INVOCATIONTARGET_EXTRACTOR</pre>
<div class="block">Default extractor for <code>InvocationTargetException</code> instances.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>InvocationTargetException.getTargetException()</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ThrowableAnalyzer</h4>
<pre>public&nbsp;ThrowableAnalyzer()</pre>
<div class="block">Creates a new <code>ThrowableAnalyzer</code> instance.</div>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="registerExtractor(java.lang.Class,org.springframework.security.web.util.ThrowableCauseExtractor)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>registerExtractor</h4>
<pre class="methodSignature">protected final&nbsp;void&nbsp;registerExtractor&#8203;(java.lang.Class&lt;? extends java.lang.Throwable&gt;&nbsp;throwableType,
                                       <a href="ThrowableCauseExtractor.html" title="interface in org.springframework.security.web.util">ThrowableCauseExtractor</a>&nbsp;extractor)</pre>
<div class="block">Registers a <code>ThrowableCauseExtractor</code> for the specified type. <i>Can be
used in subclasses overriding <a href="ThrowableAnalyzer.html#initExtractorMap()"><code>initExtractorMap()</code></a>.</i></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>throwableType</code> - the type (has to be a subclass of <code>Throwable</code>)</dd>
<dd><code>extractor</code> - the associated <code>ThrowableCauseExtractor</code> (not
<code>null</code>)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if one of the arguments is invalid</dd>
</dl>
</li>
</ul>
<a id="initExtractorMap()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>initExtractorMap</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;initExtractorMap()</pre>
<div class="block">Initializes associations between <code>Throwable</code>s and
<code>ThrowableCauseExtractor</code>s. The default implementation performs the
following registrations:
<ul>
<li><a href="ThrowableAnalyzer.html#DEFAULT_EXTRACTOR"><code>DEFAULT_EXTRACTOR</code></a> for <code>Throwable</code></li>
<li><a href="ThrowableAnalyzer.html#INVOCATIONTARGET_EXTRACTOR"><code>INVOCATIONTARGET_EXTRACTOR</code></a> for <code>InvocationTargetException</code></li>
</ul>
<br>
Subclasses overriding this method are encouraged to invoke the super method to
perform the default registrations. They can register additional extractors as
required.
<p>
Note: An extractor registered for a specific type is applicable for that type
<i>and all subtypes thereof</i>. However, extractors registered to more specific
types are guaranteed to be resolved first. So in the default case
InvocationTargetExceptions will be handled by <a href="ThrowableAnalyzer.html#INVOCATIONTARGET_EXTRACTOR"><code>INVOCATIONTARGET_EXTRACTOR</code></a>
while all other throwables are handled by <a href="ThrowableAnalyzer.html#DEFAULT_EXTRACTOR"><code>DEFAULT_EXTRACTOR</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="ThrowableAnalyzer.html#registerExtractor(java.lang.Class,org.springframework.security.web.util.ThrowableCauseExtractor)"><code>registerExtractor(Class, ThrowableCauseExtractor)</code></a></dd>
</dl>
</li>
</ul>
<a id="determineCauseChain(java.lang.Throwable)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>determineCauseChain</h4>
<pre class="methodSignature">public final&nbsp;java.lang.Throwable[]&nbsp;determineCauseChain&#8203;(java.lang.Throwable&nbsp;throwable)</pre>
<div class="block">Determines the cause chain of the provided <code>Throwable</code>. The returned
array contains all throwables extracted from the stacktrace, using the registered
<a href="ThrowableCauseExtractor.html" title="interface in org.springframework.security.web.util"><code>extractors</code></a>. The elements of the array are ordered:
The first element is the passed in throwable itself. The following elements appear
in their order downward the stacktrace.
<p>
Note: If no <a href="ThrowableCauseExtractor.html" title="interface in org.springframework.security.web.util"><code>ThrowableCauseExtractor</code></a> is registered for this instance then
the returned array will always only contain the passed in throwable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>throwable</code> - the <code>Throwable</code> to analyze</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of all determined throwables from the stacktrace</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the throwable is <code>null</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="ThrowableAnalyzer.html#initExtractorMap()"><code>initExtractorMap()</code></a></dd>
</dl>
</li>
</ul>
<a id="getFirstThrowableOfType(java.lang.Class,java.lang.Throwable[])">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirstThrowableOfType</h4>
<pre class="methodSignature">public final&nbsp;java.lang.Throwable&nbsp;getFirstThrowableOfType&#8203;(java.lang.Class&lt;? extends java.lang.Throwable&gt;&nbsp;throwableType,
                                                         java.lang.Throwable[]&nbsp;chain)</pre>
<div class="block">Returns the first throwable from the passed in array that is assignable to the
provided type. A returned instance is safe to be cast to the specified type.
<p>
If the passed in array is null or empty this method returns <code>null</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>throwableType</code> - the type to look for</dd>
<dd><code>chain</code> - the array (will be processed in element order)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the found <code>Throwable</code>, <code>null</code> if not found</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the provided type is <code>null</code> or no
subclass of <code>Throwable</code></dd>
</dl>
</li>
</ul>
<a id="verifyThrowableHierarchy(java.lang.Throwable,java.lang.Class)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>verifyThrowableHierarchy</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;verifyThrowableHierarchy&#8203;(java.lang.Throwable&nbsp;throwable,
                                            java.lang.Class&lt;? extends java.lang.Throwable&gt;&nbsp;expectedBaseType)</pre>
<div class="block">Verifies that the provided throwable is a valid subclass of the provided type (or
of the type itself). If <code>expectdBaseType</code> is <code>null</code>, no check
will be performed.
<p>
Can be used for verification purposes in implementations of
<a href="ThrowableCauseExtractor.html" title="interface in org.springframework.security.web.util"><code>extractors</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>throwable</code> - the <code>Throwable</code> to check</dd>
<dd><code>expectedBaseType</code> - the type to check against</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>throwable</code> is either
<code>null</code> or its type is not assignable to <code>expectedBaseType</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="ThrowableAnalyzer.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="ThrowableAnalyzer.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="ThrowableAnalyzer.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="ThrowableAnalyzer.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="ThrowableAnalyzer.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="ThrowableAnalyzer.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="ThrowableAnalyzer.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040f355dd7b97cf","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
